.TH "utility_handlers: simplify request processing" 3 "30 Jun 2005" "Version 5.2.1.rc3" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
utility_handlers: simplify request processing \- A group of handlers intended to simplify certain aspects of processing a request for a MIB object.  

.PP
.SS "Modules"

.in +1c
.ti -1c
.RI "\fBbulk_to_next: convert GETBULK requests into GETNEXT requests for the handler.\fP"
.br
.RI "\fIThe only purpose of this handler is to convert a GETBULK request to a GETNEXT request. \fP"
.PP
.in +1c

.ti -1c
.RI "\fBcache_handler: Maintains a cache of data for use by lower level handlers.\fP"
.br
.RI "\fIThis helper checks to see whether the data has been loaded 'recently' (according to the timeout for that particular cache) and calls the registered 'load_cache' routine if necessary. \fP"
.PP
.in +1c

.ti -1c
.RI "\fBdebug: print out debugging information about the handler chain being called.\fP"
.br
.RI "\fIThis is a useful module for run-time debugging of requests as the pass this handler in a calling chain. \fP"
.PP
.in +1c

.ti -1c
.RI "\fBmode_end_call: at the end of a series of requests, call another handler hook.\fP"
.br
.RI "\fIHandlers that want to loop through a series of requests and then receive a callback at the end of a particular MODE can use this helper to make this possible. \fP"
.PP
.in +1c

.ti -1c
.RI "\fBmultiplexer: splits mode requests into calls to different handlers.\fP"
.br
.RI "\fIThe multiplexer helper lets you split the calling chain depending on the calling mode (get vs getnext vs set). \fP"
.PP
.in +1c

.ti -1c
.RI "\fBread_only: make your handler read_only automatically\fP"
.br
.RI "\fIThe only purpose of this handler is to return an appropriate error for any requests passed to it in a SET mode. \fP"
.PP
.in +1c

.ti -1c
.RI "\fBrow_merge: Calls sub handlers with request for one row at a time.\fP"
.br
.RI "\fIThis helper splits a whole bunch of requests into chunks based on the row index that they refer to, and passes all requests for a given row to the lower handlers. \fP"
.PP
.in +1c

.ti -1c
.RI "\fBserialize: Calls sub handlers one request at a time.\fP"
.br
.RI "\fIThis functionally passes in one request at a time into lower handlers rather than a whole bunch of requests at once. \fP"
.PP

.in -1c
.SH "Detailed Description"
.PP 
A group of handlers intended to simplify certain aspects of processing a request for a MIB object. 
.PP
These helpers do not implement any MIB objects themselves. Rather they handle specific generic situations, either returning an error, or passing a (possibly simpler) request down to lower level handlers. 
